[beta] Get a ridership account.

Get a single ridership account by ID. The ID can be a Samsara UUID or an external ID in key:value format.

Rate limit: 10 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Ridership under the Ridership category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

GET /ridership/accounts/{id}

[beta] Get a ridership account.

cURL

curl --request GET \
  --url https://api.samsara.com/ridership/accounts/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "createdAtTime": "2024-11-15T10:00:00Z",
    "id": "e4b2c3a5-7d6f-4e8b-9a0c-1b2d3e4f5a6b",
    "name": "Springfield Public Schools",
    "updatedAtTime": "2024-11-15T10:30:00Z",
    "externalIds": {}
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

ID of the ridership account. This can either be the Samsara-specified UUID, or an external ID. External IDs are customer-specified key-value pairs. To specify an external ID, use the following format: key:value. For example, district:SPR-001.

Query Parameters

includeExternalIds · boolean

Optional boolean indicating whether to return external IDs on supported entities

Response

200

application/json

OK response.

data · object · required

A ridership account entity.

Show child attributes